メインコンテンツまでスキップ
バージョン: DAI 7.3

認証方法

新機能

Eggplant DAI APIは、APIを保護するために開放標準の認証（OAuth 2.0 - クライアント資格情報付与）を使用します。

Eggplant DAI Execution APIを使用するには、有効なアクセストークンが必要です。アクセストークンを取得するには：

  • あなたのインテグレーションのためのOAuth資格情報を取得します
  • 下記に示す生成されたトークンエンドポイントに、あなたのOAuth資格情報を含む認証リクエストを送信します。

トークンは5分後に有効期限が切れるため、アクセスを維持するには、定期的にあなたの資格情報を再送信して新しいアクセストークンを取得する必要があります。

これの具体的な手順については、Getting Startedをご覧ください。

認証方法​

POST -> http://localhost:8000/auth/realms/{realm}/protocol/openid-connect/token

ヘッダー​

名前値
Content-Typeapplication/x-www-form-urlencoded

ボディParameter​

名前タイプ説明必須
grant_typestringタイプ：client_credentials
あなたのOAuth資格情報を使用してアクセストークンを生成します。		はい
client_idstringあなたのclient_idはい
client_secretstringあなたのclient_secretはい

可能なレスポンス​

ステータスステータステキスト説明
200OK成功した応答
400Bad request必要なParameterが送信されていません
401Bad request無効な資格情報が提供されました。
403禁止されています十分な同時ユーザーライセンスが利用できません

レスポンスボディJSON​

以下の最初の例は、成功した応答（ステータス200）を示しています。

例：

{
      "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia...",
      "expires_in": 300,
      "refresh_expires_in": 0,
      "token_type": "Bearer",
      "not-before-policy": 0,
      "scope": "email template:dai:agents profile"
  }
名前タイプ説明値
access_tokenstring認証に成功したユーザーアカウントのアクセストークン<dynamic>
expires_inintegerアクセストークンが有効である秒数。300 (または5分)
refresh_expires_inintegerリフレッシュトークンが有効である秒数。1800 (または30分)
token_typestringOAuth 2.0で使用されるアクセストークンのタイプ。bearer
not-before-policybooleanポリシーは無効化されています。0
scopestringシステム管理者の権限をアクセストークンを使用するリソースまたはアプリケーションに付与しますemail template:dai:agents profile

次の例は、無効なレスポンスステータス401未認証を示しています。

例：

{
  "message": "Not Authorized",
  "description": "The credentials you provided are not valid."
}
に最終更新